man/ostree-state-overlay: drop experimental but link to bootc docs
authorJonathan Lebon <jonathan@jlebon.com>
Thu, 11 Sep 2025 19:28:34 +0000 (15:28 -0400)
committerJonathan Lebon <jonathan@jlebon.com>
Thu, 11 Sep 2025 19:28:34 +0000 (15:28 -0400)
This has baked for long enough now so drop the experimental flag. But do
explain that symlinks are preferred and link to the bootc docs.

man/ostree-state-overlay@.service.xml

index 7f24f2531f7ea3d6c621aeec4f4e2fdaa213217b..f670198a0cb2302ebab0a1dea2f7c211a7004c48 100644 (file)
@@ -44,15 +44,14 @@ Boston, MA 02111-1307, USA.
   </refsynopsisdiv>
 
   <refsect1>
-    <title>Experimental</title>
+    <title>Dealing with /opt</title>
     <para>
-      <emphasis role="bold">Note this feature is currently considered
-      experimental.</emphasis> It may not work correctly and some of its
-      semantics may be subject to change. Positive or negative feedback are both
-      welcome and may be provided at
-      <ulink url="https://github.com/ostreedev/ostree/discussions"/>. If using
-      the feature via rpm-ostree, feedback may also be provided at
-      <ulink url="https://github.com/coreos/rpm-ostree/issues/233"/>.
+      <emphasis role="bold">Note:</emphasis> In general, the preference for
+      handling <filename>/opt</filename> software is to use symbolic links for
+      just the parts that need to be mutable to some place in
+      <filename>/var</filename> that can be created e.g. by a
+      <literal>tmpfiles.d</literal> dropin. For more information, see
+      <ulink url="https://bootc-dev.github.io/bootc/building/guidance.html#handling-read-only-vs-writable-locations"/>.
     </para>
   </refsect1>